Cisco Packet Tracer Extensions API 8.1.0
API for communication between Cisco Packet Tracer application and its extension applications and modules.
Public Member Functions | List of all members
WirelessServerProcess Class Reference
Inheritance diagram for WirelessServerProcess:
WirelessCommon Process

Public Member Functions

bool isMacFilterEnabled ()
 Gets the mac filtering enable or disable state. More...
 
void setMacFilterEnabled (bool)
 Enables/Disables wireless mac filtering. More...
 
void setAllowAccess (bool)
 Sets the mode to allow access from listed mac addresses, or deny access for listed mac addresses. More...
 
bool isAccessAllowed ()
 Gets the mode to allow access from listed mac addresses, or deny access for listed mac addresses. More...
 
void removeAllMacEntries ()
 Clears the mac filtering table. More...
 
vector< mac > getAllMacEntries ()
 Gets all of the mac entries. More...
 
int getMacAddressCount ()
 Gets the count of the mac addresses. More...
 
mac getMacAddressAt (int)
 Gets the mac entry at index. More...
 
void resetAllAssociations ()
 Resets wireless client associations so that the new filters will affect existing associations. More...
 
void addToMacFilterAddrList (mac)
 Add a mac address to the filtering table. More...
 
void removeFromMacFilterAddrList (mac)
 Removes a mac address from the filtering table. More...
 
bool isSsidBrdCastEnabled ()
 Check if ssid broadcast is enabled. More...
 
void setSsidBrdCastEnabled (bool)
 Set Ssid broadcast enabled. More...
 
- Public Member Functions inherited from WirelessCommon
WirelessAuthenType getAuthenType ()
 Returns the authentication type. More...
 
void setAuthenType (WirelessAuthenType)
 
void setSsid (string)
 Sets the SSID. More...
 
string getSsid ()
 Returns the SSID. More...
 
WirelessNetworkType getNetworkType ()
 Returns the network type. More...
 
void setNetworkType (WirelessNetworkType)
 
bool setPort (string)
 Sets the wireless port with the specified port. More...
 
Port getPort ()
 Returns the wireless port. More...
 
WEPProcess getWepProcess ()
 Returns the WEP process. More...
 
void resetAllAssociations ()
 Resets all wireless associations. More...
 
WirelessEncryptType getEncryptType ()
 Get encryption type. More...
 
void setEncryptType (WirelessEncryptType)
 Set encryption type \para type, enum<WirelessEncryptType> eEncryptNull = 0, eEncryptWep_64bit = 1, eEncryptWep_128bit = 2, eEncryptTKIP = 3, //Arun wpa eEncryptAES = 4. More...
 
void setStandardChannel (StandardChannel)
 Set standard channel \para type, enum<StandardChannel>
eStandardChannel_1 = 0, // channel: 1 - 2.412GHz eStandardChannel_2 = 1, // channel: 2 - 2.417GHz eStandardChannel_3 = 2, // channel: 3 - 2.422GHz eStandardChannel_4 = 3, // channel: 4 - 2.427GHz eStandardChannel_5 = 4, // channel: 5 - 2.432GHz eStandardChannel_6 = 5, // channel: 6 - 2.437GHz eStandardChannel_7 = 6, // channel: 7 - 2.442GHz eStandardChannel_8 = 7, // channel: 8 - 2.447GHz eStandardChannel_9 = 8, // channel: 9 - 2.452GHz eStandardChannel_10 = 9, // channel: 10 - 2.457GHz eStandardChannel_11 = 10 // channel: 11 - 2.462GHz. More...
 
StandardChannel getStandardChannel ()
 Get standard channel. More...
 
void setWideChannel (WideChannel)
 Set wide channel. More...
 
WideChannel getWideChannel ()
 Get wide channel. More...
 
WirelessRadioBand getRadioBand ()
 Get radio band. More...
 
void setRadioBand (WirelessRadioBand)
 Set radio band. More...
 
WPAProcess getWpaProcess ()
 Get Wpa Process. More...
 
- Public Member Functions inherited from Process
Device getOwnerDevice ()
 Returns the device for this process. More...
 

Detailed Description

\brief WirelessServerProcess handles and manipulates wireless servers.

\example network().getDevice("PC0").getProcess("WirelessServer")

Member Function Documentation

◆ addToMacFilterAddrList()

void WirelessServerProcess::addToMacFilterAddrList ( mac  )

Add a mac address to the filtering table.

Parameters
macString of the mac address
Returns
bool whether adding was successful. Adding an existing mac will be considered successful.

◆ getAllMacEntries()

vector< mac > WirelessServerProcess::getAllMacEntries ( )

Gets all of the mac entries.

◆ getMacAddressAt()

mac WirelessServerProcess::getMacAddressAt ( int  )

Gets the mac entry at index.

Parameters
indexthe index of the desired mac address

◆ getMacAddressCount()

int WirelessServerProcess::getMacAddressCount ( )

Gets the count of the mac addresses.

◆ isAccessAllowed()

bool WirelessServerProcess::isAccessAllowed ( )

Gets the mode to allow access from listed mac addresses, or deny access for listed mac addresses.

Returns
If the current mode is to allow access or deny access. True mean listed macs are allowed.

◆ isMacFilterEnabled()

bool WirelessServerProcess::isMacFilterEnabled ( )

Gets the mac filtering enable or disable state.

Returns
Whether mac filtering is enabled or disabled. True is enabled.

◆ isSsidBrdCastEnabled()

bool WirelessServerProcess::isSsidBrdCastEnabled ( )

Check if ssid broadcast is enabled.

Returns
bool, true if ssid broadcast is enabled and false if not

◆ removeAllMacEntries()

void WirelessServerProcess::removeAllMacEntries ( )

Clears the mac filtering table.

◆ removeFromMacFilterAddrList()

void WirelessServerProcess::removeFromMacFilterAddrList ( mac  )

Removes a mac address from the filtering table.

Parameters
macThe mac addres to remove

◆ resetAllAssociations()

void WirelessServerProcess::resetAllAssociations ( )

Resets wireless client associations so that the new filters will affect existing associations.

◆ setAllowAccess()

void WirelessServerProcess::setAllowAccess ( bool  )

Sets the mode to allow access from listed mac addresses, or deny access for listed mac addresses.

Parameters
enabletrue means allow listed mac addresses to use it. false means deny listed mac addresses.

◆ setMacFilterEnabled()

void WirelessServerProcess::setMacFilterEnabled ( bool  )

Enables/Disables wireless mac filtering.

Parameters
enableWhether to enable or disable it.

◆ setSsidBrdCastEnabled()

void WirelessServerProcess::setSsidBrdCastEnabled ( bool  )

Set Ssid broadcast enabled.

Parameters
enabled,trueif ssid broadcast is enabled and false if not

The documentation for this class was generated from the following file: